<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Role mapping resources | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="api-definitions.html" title="Definitions">
<link rel="prev" href="api-definitions.html" title="Definitions">
<link rel="next" href="breaking-changes.html" title="Breaking changes">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="api-definitions.html">Definitions</a></span>
»
<span class="breadcrumb-node">Role mapping resources</span>
</div>
<div class="navheader">
<span class="prev">
<a href="api-definitions.html">« Definitions</a>
</span>
<span class="next">
<a href="breaking-changes.html">Breaking changes »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="role-mapping-resources"></a>Role mapping resources<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>
<p>A role mapping resource has the following properties:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">enabled</code>
</span>
</dt>
<dd>
(boolean)  Mappings that have <code class="literal">enabled</code> set to <code class="literal">false</code> are ignored when role
mapping is performed.
</dd>
<dt>
<span class="term">
<code class="literal">metadata</code>
</span>
</dt>
<dd>
(object) Additional metadata that helps define which roles are assigned to each
user. Within the <code class="literal">metadata</code> object, keys beginning with <code class="literal">_</code> are reserved for
system usage.
</dd>
<dt>
<span class="term">
<code class="literal">roles</code>
</span>
</dt>
<dd>
(list) A list of roles that are granted to the users that match the role mapping
rules.
</dd>
<dt>
<span class="term">
<code class="literal">rules</code>
</span>
</dt>
<dd>
<p>
(object) The rules that determine which users should be matched by the mapping.
A rule is a logical condition that is expressed by using a JSON DSL. The DSL supports the following rule types:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">any</code>
</span>
</dt>
<dd>
(array of rules) If <span class="strong strong"><strong>any</strong></span> of its children are true, it evaluates to <code class="literal">true</code>.
</dd>
<dt>
<span class="term">
<code class="literal">all</code>
</span>
</dt>
<dd>
(array of rules) If <span class="strong strong"><strong>all</strong></span> of its children are true, it evaluates to <code class="literal">true</code>.
</dd>
<dt>
<span class="term">
<code class="literal">field</code>
</span>
</dt>
<dd>
(object) See <a class="xref" href="role-mapping-resources.html#mapping-roles-rule-field" title="Field rules">Field rules</a>.
</dd>
<dt>
<span class="term">
<code class="literal">except</code>
</span>
</dt>
<dd>
(object) A single rule as an object. Only valid as a child of an <code class="literal">all</code> rule. If
its child is <code class="literal">false</code>, the <code class="literal">except</code> is <code class="literal">true</code>.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<h4>
<a id="mapping-roles-rule-field"></a>Field rules<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc">edit</a>
</h4>
<p>The <code class="literal">field</code> rule is the primary building block for a role mapping expression.
It takes a single object as its value and that object must contain a single
member with key <em>F</em> and value <em>V</em>. The field rule looks up the value of <em>F</em>
within the user object and then tests whether the user value <em>matches</em> the
provided value <em>V</em>.</p>
<p>The value specified in the field rule can be one of the following types:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1">
<col class="col_2">
<col class="col_3">
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Description</th>
<th align="left" valign="top">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p>Simple String</p></td>
<td align="left" valign="top"><p>Exactly matches the provided value.</p></td>
<td align="left" valign="top"><p><code class="literal">"esadmin"</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Wildcard String</p></td>
<td align="left" valign="top"><p>Matches the provided value using a wildcard.</p></td>
<td align="left" valign="top"><p><code class="literal">"*,dc=example,dc=com"</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Regular Expression</p></td>
<td align="left" valign="top"><p>Matches the provided value using a
                       <a class="xref" href="regexp-syntax.html" title="Regular expression syntax">Lucene regexp</a>.</p></td>
<td align="left" valign="top"><p><code class="literal">"/.*-admin[0-9]*/"</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Number</p></td>
<td align="left" valign="top"><p>Matches an equivalent numerical value.</p></td>
<td align="left" valign="top"><p><code class="literal">7</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Null</p></td>
<td align="left" valign="top"><p>Matches a null or missing value.</p></td>
<td align="left" valign="top"><p><code class="literal">null</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Array</p></td>
<td align="left" valign="top"><p>Tests each element in the array in
                      accordance with the above definitions.
                      If <em>any</em> of elements match, the match is successful.</p></td>
<td align="left" valign="top"><p><code class="literal">["admin", "operator"]</code></p></td>
</tr>
</tbody>
</table>
</div>
<h5>
<a id="_user_fields"></a>User fields<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc">edit</a>
</h5>
<p>The <em>user object</em> against which rules are evaluated has the following fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">username</code>
</span>
</dt>
<dd>
(string) The username by which the Elasticsearch security features knows this user. For
example, <code class="literal">"username": "jsmith"</code>.
</dd>
<dt>
<span class="term">
<code class="literal">dn</code>
</span>
</dt>
<dd>
(string) The <em>Distinguished Name</em> of the user. For example, <code class="literal">"dn": "cn=jsmith,ou=users,dc=example,dc=com",</code>.
</dd>
<dt>
<span class="term">
<code class="literal">groups</code>
</span>
</dt>
<dd>
(array of strings) The groups to which the user belongs. For example, <code class="literal">"groups" : [ "cn=admin,ou=groups,dc=example,dc=com","cn=esusers,ou=groups,dc=example,dc=com ]</code>.
</dd>
<dt>
<span class="term">
<code class="literal">metadata</code>
</span>
</dt>
<dd>
(object) Additional metadata for the user. For example, <code class="literal">"metadata": { "cn": "John Smith" }</code>.
</dd>
<dt>
<span class="term">
<code class="literal">realm</code>
</span>
</dt>
<dd>
(object) The realm that authenticated the user. The only field in this object is the realm name. For example, <code class="literal">"realm": { "name": "ldap1" }</code>.
</dd>
</dl>
</div>
<p>The <code class="literal">groups</code> field is multi-valued; a user can belong to many groups. When a
<code class="literal">field</code> rule is applied against a multi-valued field, it is considered to match
if <em>at least one</em> of the member values matches. For example, the following rule
matches any user who is a member of the <code class="literal">admin</code> group, regardless of any
other groups they belong to:</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">{ "field" : { "groups" : "admin" } }</pre>
</div>
<p>For additional realm-specific details, see
<a class="xref" href="mapping-roles.html#ldap-role-mapping" title="Active Directory and LDAP realms">Active Directory and LDAP realms</a>.</p>
</div>
<div class="navfooter">
<span class="prev">
<a href="api-definitions.html">« Definitions</a>
</span>
<span class="next">
<a href="breaking-changes.html">Breaking changes »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
